////////////////////////////////////////////////////////////////////////////////
// Copyright 2010 Michael Schmalle - Teoti Graphix, LLC
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0 
// 
// Unless required by applicable law or agreed to in writing, software 
// distributed under the License is distributed on an "AS IS" BASIS, 
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and 
// limitations under the License
// 
// Author: Michael Schmalle, Principal Architect
// mschmalle at teotigraphix dot com
////////////////////////////////////////////////////////////////////////////////

package org.teotigraphix.swizplugin.api
{

/**
 * The <strong>IPluginExtension</strong> interface creates a contract
 * with classes wishing to add extensions of <code>IPluginExtensionPoint</code>
 * to the extension registry.
 * 
 * @author Michael Schmalle
 * @copyright Teoti Graphix, LLC
 * @productversion 1.0
 */
public interface IPluginExtension
{
	//--------------------------------------------------------------------------
	//
	//  Properties
	//
	//--------------------------------------------------------------------------
	
	//----------------------------------
	//  uid
	//----------------------------------
	
	/**
	 * The <strong>IPluginExtension</strong> id such as 
	 * <strong>com.acme.ui.views.myUniqueExtension</strong>.
	 * 
	 * <p>The identifier needs to be unique within an extension registry.</p>
	 * 
	 * <p><strong>Note:</strong> This identifier is not required for an extension. 
	 * Times that this would need to be set is when using the method 
	 * <code>IExtensionRegistry.getExtension()</code> from the extension registry.</p>
	 * 
	 * @see org.teotigraphix.swizplugin.registry.IExtensionRegistry#getExtension()
	 */
	function get uid():String;
	
	/**
	 * @private
	 */
	function set uid(value:String):void;
	
	//----------------------------------
	//  name
	//----------------------------------

	/**
	 * The human readable name of the extension.
	 */
	function get name():String;
	
	/**
	 * @private
	 */
	function set name(value:String):void;
	
	//----------------------------------
	//  point
	//----------------------------------

	/**
	 * The <code>IPluginExtensionPoint#uid</code> this extension is extending.
	 * 
	 * @see org.teotigraphix.swizplugin.api.IPluginExtensionPoint#uid
	 */
	function get point():String;
	
	/**
	 * @private
	 */
	function set point(value:String):void;
}
}